//
//  NSAttributedString+HTML.m
//
//  Created by Derek Bowen <dbowen@demiurgic.co>
//  Copyright (c) 2012-2015, Deloitte Digital
//  All rights reserved.
//
//  Redistribution and use in source and binary forms, with or without
//  modification, are permitted provided that the following conditions are met:
//  * Redistributions of source code must retain the above copyright
//    notice, this list of conditions and the following disclaimer.
//  * Redistributions in binary form must reproduce the above copyright
//    notice, this list of conditions and the following disclaimer in the
//    documentation and/or other materials provided with the distribution.
//  * Neither the name of the <organization> nor the
//    names of its contributors may be used to endorse or promote products
//    derived from this software without specific prior written permission.
//
//  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
//  ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
//  WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
//  DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
//  DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
//  (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
//  LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
//  ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
//  (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
//  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
//

#import <Foundation/Foundation.h>
#import <UIKit/UIKit.h>

NS_ASSUME_NONNULL_BEGIN

@interface NSAttributedString (DDHTML)

/**
 *  Generates an attributed string from HTML.
 *
 *  @param htmlString HTML String
 *
 *  @return Attributed string
 */
+ (NSAttributedString *)attributedStringFromHTML:(NSString *)htmlString;

/**
 *  Generates an attributed string from HTML.
 *
 *  @param htmlString HTML String
 *  @param boldFont   Font to use for \<b\> and \<strong\> tags
 *  @param italicFont Font to use for \<i\> and \<em\> tags
 *
 *  @return Attributed string
 */
+ (NSAttributedString *)attributedStringFromHTML:(NSString *)htmlString boldFont:(UIFont *)boldFont italicFont:(UIFont *)italicFont;

/**
 *  Generates an attributed string from HTML.
 *
 *  @param htmlString HTML String
 *  @param normalFont Font to use for general text
 *  @param boldFont   Font to use for \<b\> and \<strong\> tags
 *  @param italicFont Font to use for \<i\> and \<em\> tags
 *
 *  @return Attributed string
 */
+ (NSAttributedString *)attributedStringFromHTML:(NSString *)htmlString normalFont:(UIFont *)normalFont boldFont:(UIFont *)boldFont italicFont:(UIFont *)italicFont;

/**
 *  Generates an attributed string from HTML.
 *
 *  @param htmlString   HTML String
 *  @param normalFont   Font to use for general text
 *  @param boldFont     Font to use for \<b\> and \<strong\> tags
 *  @param italicFont   Font to use for \<i\> and \<em\> tags
 *  @param imageMap     Images to use in place of standard bundle images.
 *
 *  @return Attributed string
 */
+ (NSAttributedString *)attributedStringFromHTML:(NSString *)htmlString normalFont:(UIFont *)normalFont boldFont:(UIFont *)boldFont italicFont:(UIFont *)italicFont imageMap:(NSDictionary<NSString *, UIImage *> *)imageMap;

@end

NS_ASSUME_NONNULL_END
